home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1996 February: Tool Chest / Apple Developer CD Series Tool Chest February 1996 (Apple Computer)(1996).iso / Tool Chest / Interfaces & Libraries / Interfaces / PInterfaces / Menus.p < prev    next >
Encoding:
Text File  |  1995-07-06  |  11.3 KB  |  428 lines  |  [TEXT/MPS ]
  1. {
  2.      File:        Menus.p
  3.  
  4.      Contains:    Menu Manager Interfaces.
  5.  
  6.      Version:    Technology:    System 7.5
  7.                  Package:    Universal Interfaces 2.1 in “MPW Latest” on ETO #18
  8.  
  9.      Copyright:    © 1984-1995 by Apple Computer, Inc.
  10.                  All rights reserved.
  11.  
  12.      Bugs?:        If you find a problem with this file, use the Apple Bug Reporter
  13.                  stack.  Include the file and version information (from above)
  14.                  in the problem description and send to:
  15.                      Internet:    apple.bugs@applelink.apple.com
  16.                      AppleLink:    APPLE.BUGS
  17.  
  18. }
  19.  
  20. {$IFC UNDEFINED UsingIncludes}
  21. {$SETC UsingIncludes := 0}
  22. {$ENDC}
  23.  
  24. {$IFC NOT UsingIncludes}
  25.  UNIT Menus;
  26.  INTERFACE
  27. {$ENDC}
  28.  
  29. {$IFC UNDEFINED __MENUS__}
  30. {$SETC __MENUS__ := 1}
  31.  
  32. {$I+}
  33. {$SETC MenusIncludes := UsingIncludes}
  34. {$SETC UsingIncludes := 1}
  35.  
  36.  
  37. {$IFC UNDEFINED __MEMORY__}
  38. {$I Memory.p}
  39. {$ENDC}
  40. {    Types.p                                                        }
  41. {        ConditionalMacros.p                                        }
  42. {    MixedMode.p                                                    }
  43.  
  44. {$IFC UNDEFINED __QUICKDRAW__}
  45. {$I Quickdraw.p}
  46. {$ENDC}
  47. {    QuickdrawText.p                                                }
  48.  
  49. {$PUSH}
  50. {$ALIGN MAC68K}
  51. {$LibExport+}
  52.  
  53. CONST
  54.     noMark                        = 0;                            {mark symbol for MarkItem}
  55. { menu defProc messages }
  56.     mDrawMsg                    = 0;
  57.     mChooseMsg                    = 1;
  58.     mSizeMsg                    = 2;
  59.     mDrawItemMsg                = 4;
  60.     mCalcItemMsg                = 5;
  61.     textMenuProc                = 0;
  62.     hMenuCmd                    = 27;                            {itemCmd == 0x001B ==> hierarchical menu}
  63.     hierMenu                    = -1;                            {a hierarchical menu - for InsertMenu call}
  64.     mPopUpMsg                    = 3;                            {menu defProc messages - place yourself}
  65.     mctAllItems                    = -98;                            {search for all Items for the given ID}
  66.     mctLastIDIndic                = -99;                            {last color table entry has this in ID field}
  67.  
  68. {$IFC UNDEFINED STRICT_MENUS }
  69. {$SETC STRICT_MENUS := 0}
  70. {$ENDC}
  71. {$IFC STRICT_MENUS }
  72.     
  73. TYPE
  74.     MenuRef = Ptr;
  75.  
  76.     MenuHandle = MenuRef;
  77.  
  78. {$ELSEC}
  79.  
  80. TYPE
  81.     MenuInfo = RECORD
  82.         menuID:                    INTEGER;
  83.         menuWidth:                INTEGER;
  84.         menuHeight:                INTEGER;
  85.         menuProc:                Handle;
  86.         enableFlags:            LONGINT;
  87.         menuData:                Str255;
  88.     END;
  89.  
  90.     MenuPtr = ^MenuInfo;
  91.     MenuHandle = ^MenuPtr;
  92.  
  93.     MenuRef = MenuHandle;
  94.  
  95. {$ENDC}
  96.     MenuDefProcPtr = ProcPtr;  { PROCEDURE MenuDef(message: INTEGER; theMenu: MenuRef; VAR menuRect: Rect; hitPt: Point; VAR whichItem: INTEGER); }
  97.     MenuBarDefProcPtr = ProcPtr;  { FUNCTION MenuBarDef(selector: INTEGER; message: INTEGER; parameter1: INTEGER; parameter2: LONGINT): LONGINT; }
  98.     MenuHookProcPtr = ProcPtr;  { PROCEDURE MenuHook; }
  99.     MBarHookProcPtr = ProcPtr;  { FUNCTION MBarHook(VAR menuRect: Rect): INTEGER; }
  100.     MenuDefUPP = UniversalProcPtr;
  101.     MenuBarDefUPP = UniversalProcPtr;
  102.     MenuHookUPP = UniversalProcPtr;
  103.     MBarHookUPP = UniversalProcPtr;
  104.  
  105. CONST
  106.     uppMenuDefProcInfo = $0000FF80; { PROCEDURE (2 byte param, 4 byte param, 4 byte param, 4 byte param, 4 byte param); }
  107.     uppMenuBarDefProcInfo = $00003AB0; { FUNCTION (2 byte param, 2 byte param, 2 byte param, 4 byte param): 4 byte result; }
  108.     uppMenuHookProcInfo = $00000000; { PROCEDURE ; }
  109.     uppMBarHookProcInfo = $000000CF; { SPECIAL_CASE_PROCINFO( kSpecialCaseMBarHook ) }
  110.  
  111. FUNCTION NewMenuDefProc(userRoutine: MenuDefProcPtr): MenuDefUPP;
  112.     {$IFC NOT GENERATINGCFM }
  113.     INLINE $2E9F;
  114.     {$ENDC}
  115.  
  116. FUNCTION NewMenuBarDefProc(userRoutine: MenuBarDefProcPtr): MenuBarDefUPP;
  117.     {$IFC NOT GENERATINGCFM }
  118.     INLINE $2E9F;
  119.     {$ENDC}
  120.  
  121. FUNCTION NewMenuHookProc(userRoutine: MenuHookProcPtr): MenuHookUPP;
  122.     {$IFC NOT GENERATINGCFM }
  123.     INLINE $2E9F;
  124.     {$ENDC}
  125.  
  126. FUNCTION NewMBarHookProc(userRoutine: MBarHookProcPtr): MBarHookUPP;
  127.     {$IFC NOT GENERATINGCFM }
  128.     INLINE $2E9F;
  129.     {$ENDC}
  130.  
  131. PROCEDURE CallMenuDefProc(message: INTEGER; theMenu: MenuRef; VAR menuRect: Rect; hitPt: Point; VAR whichItem: INTEGER; userRoutine: MenuDefUPP);
  132.     {$IFC NOT GENERATINGCFM}
  133.     INLINE $205F, $4E90;
  134.     {$ENDC}
  135.  
  136. FUNCTION CallMenuBarDefProc(selector: INTEGER; message: INTEGER; parameter1: INTEGER; parameter2: LONGINT; userRoutine: MenuBarDefUPP): LONGINT;
  137.     {$IFC NOT GENERATINGCFM}
  138.     INLINE $205F, $4E90;
  139.     {$ENDC}
  140.  
  141. PROCEDURE CallMenuHookProc(userRoutine: MenuHookUPP);
  142.     {$IFC NOT GENERATINGCFM}
  143.     INLINE $205F, $4E90;
  144.     {$ENDC}
  145.  
  146. FUNCTION CallMBarHookProc(VAR menuRect: Rect; userRoutine: MBarHookUPP): INTEGER;
  147.     {$IFC NOT GENERATINGCFM}
  148.     {To be implemented:  Glue to move parameters according to special case conventions.}
  149.     {$ENDC}
  150.  
  151. TYPE
  152.     MCEntry = RECORD
  153.         mctID:                    INTEGER;                                {menu ID.  ID = 0 is the menu bar}
  154.         mctItem:                INTEGER;                                {menu Item. Item = 0 is a title}
  155.         mctRGB1:                RGBColor;                                {usage depends on ID and Item}
  156.         mctRGB2:                RGBColor;                                {usage depends on ID and Item}
  157.         mctRGB3:                RGBColor;                                {usage depends on ID and Item}
  158.         mctRGB4:                RGBColor;                                {usage depends on ID and Item}
  159.         mctReserved:            INTEGER;                                {reserved for internal use}
  160.     END;
  161.  
  162.     MCEntryPtr = ^MCEntry;
  163.  
  164.     MCTable = ARRAY [0..0] OF MCEntry;
  165.  
  166.     MCTablePtr = ^MCTable;
  167.     MCTableHandle = ^MCTablePtr;
  168.  
  169.     MenuCRsrc = RECORD
  170.         numEntries:                INTEGER;                                {number of entries}
  171.         mcEntryRecs:            MCTable;                                {ARRAY [1..numEntries] of MCEntry}
  172.     END;
  173.  
  174.     MenuCRsrcPtr = ^MenuCRsrc;
  175.     MenuCRsrcHandle = ^MenuCRsrcPtr;
  176.  
  177. FUNCTION GetMBarHeight : INTEGER;
  178.     {$IFC NOT CFMSYSTEMCALLS}
  179.     INLINE $3EB8, $0BAA;            { MOVE.w $0BAA,(SP) }
  180.     {$ENDC}
  181.  
  182. PROCEDURE InitMenus;
  183.     {$IFC NOT GENERATINGCFM}
  184.     INLINE $A930;
  185.     {$ENDC}
  186. FUNCTION NewMenu(menuID: INTEGER; menuTitle: ConstStr255Param): MenuRef;
  187.     {$IFC NOT GENERATINGCFM}
  188.     INLINE $A931;
  189.     {$ENDC}
  190. FUNCTION GetMenu(resourceID: INTEGER): MenuRef;
  191.     {$IFC NOT GENERATINGCFM}
  192.     INLINE $A9BF;
  193.     {$ENDC}
  194. PROCEDURE DisposeMenu(theMenu: MenuRef);
  195.     {$IFC NOT GENERATINGCFM}
  196.     INLINE $A932;
  197.     {$ENDC}
  198. PROCEDURE AppendMenu(menu: MenuRef; data: ConstStr255Param);
  199.     {$IFC NOT GENERATINGCFM}
  200.     INLINE $A933;
  201.     {$ENDC}
  202. PROCEDURE AppendResMenu(theMenu: MenuRef; theType: ResType);
  203.     {$IFC NOT GENERATINGCFM}
  204.     INLINE $A94D;
  205.     {$ENDC}
  206. PROCEDURE InsertResMenu(theMenu: MenuRef; theType: ResType; afterItem: INTEGER);
  207.     {$IFC NOT GENERATINGCFM}
  208.     INLINE $A951;
  209.     {$ENDC}
  210. PROCEDURE InsertMenu(theMenu: MenuRef; beforeID: INTEGER);
  211.     {$IFC NOT GENERATINGCFM}
  212.     INLINE $A935;
  213.     {$ENDC}
  214. PROCEDURE DrawMenuBar;
  215.     {$IFC NOT GENERATINGCFM}
  216.     INLINE $A937;
  217.     {$ENDC}
  218. PROCEDURE InvalMenuBar;
  219.     {$IFC NOT GENERATINGCFM}
  220.     INLINE $A81D;
  221.     {$ENDC}
  222. PROCEDURE DeleteMenu(menuID: INTEGER);
  223.     {$IFC NOT GENERATINGCFM}
  224.     INLINE $A936;
  225.     {$ENDC}
  226. PROCEDURE ClearMenuBar;
  227.     {$IFC NOT GENERATINGCFM}
  228.     INLINE $A934;
  229.     {$ENDC}
  230. FUNCTION GetNewMBar(menuBarID: INTEGER): Handle;
  231.     {$IFC NOT GENERATINGCFM}
  232.     INLINE $A9C0;
  233.     {$ENDC}
  234. FUNCTION GetMenuBar: Handle;
  235.     {$IFC NOT GENERATINGCFM}
  236.     INLINE $A93B;
  237.     {$ENDC}
  238. PROCEDURE SetMenuBar(menuList: Handle);
  239.     {$IFC NOT GENERATINGCFM}
  240.     INLINE $A93C;
  241.     {$ENDC}
  242. PROCEDURE InsertMenuItem(theMenu: MenuRef; itemString: ConstStr255Param; afterItem: INTEGER);
  243.     {$IFC NOT GENERATINGCFM}
  244.     INLINE $A826;
  245.     {$ENDC}
  246. PROCEDURE DeleteMenuItem(theMenu: MenuRef; item: INTEGER);
  247.     {$IFC NOT GENERATINGCFM}
  248.     INLINE $A952;
  249.     {$ENDC}
  250. FUNCTION MenuKey(ch: CHAR): LONGINT;
  251.     {$IFC NOT GENERATINGCFM}
  252.     INLINE $A93E;
  253.     {$ENDC}
  254. PROCEDURE HiliteMenu(menuID: INTEGER);
  255.     {$IFC NOT GENERATINGCFM}
  256.     INLINE $A938;
  257.     {$ENDC}
  258. PROCEDURE SetMenuItemText(theMenu: MenuRef; item: INTEGER; itemString: ConstStr255Param);
  259.     {$IFC NOT GENERATINGCFM}
  260.     INLINE $A947;
  261.     {$ENDC}
  262. PROCEDURE GetMenuItemText(theMenu: MenuRef; item: INTEGER; VAR itemString: Str255);
  263.     {$IFC NOT GENERATINGCFM}
  264.     INLINE $A946;
  265.     {$ENDC}
  266. PROCEDURE DisableItem(theMenu: MenuRef; item: INTEGER);
  267.     {$IFC NOT GENERATINGCFM}
  268.     INLINE $A93A;
  269.     {$ENDC}
  270. PROCEDURE EnableItem(theMenu: MenuRef; item: INTEGER);
  271.     {$IFC NOT GENERATINGCFM}
  272.     INLINE $A939;
  273.     {$ENDC}
  274. PROCEDURE CheckItem(theMenu: MenuRef; item: INTEGER; checked: BOOLEAN);
  275.     {$IFC NOT GENERATINGCFM}
  276.     INLINE $A945;
  277.     {$ENDC}
  278. PROCEDURE SetItemMark(theMenu: MenuRef; item: INTEGER; markChar: CHAR);
  279.     {$IFC NOT GENERATINGCFM}
  280.     INLINE $A944;
  281.     {$ENDC}
  282. PROCEDURE GetItemMark(theMenu: MenuRef; item: INTEGER; VAR markChar: CHAR);
  283.     {$IFC NOT GENERATINGCFM}
  284.     INLINE $A943;
  285.     {$ENDC}
  286. PROCEDURE SetItemIcon(theMenu: MenuRef; item: INTEGER; iconIndex: INTEGER);
  287.     {$IFC NOT GENERATINGCFM}
  288.     INLINE $A940;
  289.     {$ENDC}
  290. PROCEDURE GetItemIcon(theMenu: MenuRef; item: INTEGER; VAR iconIndex: Byte);
  291.     {$IFC NOT GENERATINGCFM}
  292.     INLINE $A93F;
  293.     {$ENDC}
  294. PROCEDURE SetItemStyle(theMenu: MenuRef; item: INTEGER; chStyle: Style);
  295.     {$IFC NOT GENERATINGCFM}
  296.     INLINE $A942;
  297.     {$ENDC}
  298. PROCEDURE GetItemStyle(theMenu: MenuRef; item: INTEGER; VAR chStyle: Style);
  299. PROCEDURE CalcMenuSize(theMenu: MenuRef);
  300.     {$IFC NOT GENERATINGCFM}
  301.     INLINE $A948;
  302.     {$ENDC}
  303. FUNCTION CountMItems(theMenu: MenuRef): INTEGER;
  304.     {$IFC NOT GENERATINGCFM}
  305.     INLINE $A950;
  306.     {$ENDC}
  307. FUNCTION GetMenuHandle(menuID: INTEGER): MenuRef;
  308.     {$IFC NOT GENERATINGCFM}
  309.     INLINE $A949;
  310.     {$ENDC}
  311. PROCEDURE FlashMenuBar(menuID: INTEGER);
  312.     {$IFC NOT GENERATINGCFM}
  313.     INLINE $A94C;
  314.     {$ENDC}
  315. PROCEDURE SetMenuFlash(count: INTEGER);
  316.     {$IFC NOT GENERATINGCFM}
  317.     INLINE $A94A;
  318.     {$ENDC}
  319. FUNCTION MenuSelect(startPt: Point): LONGINT;
  320.     {$IFC NOT GENERATINGCFM}
  321.     INLINE $A93D;
  322.     {$ENDC}
  323. PROCEDURE InitProcMenu(resID: INTEGER);
  324.     {$IFC NOT GENERATINGCFM}
  325.     INLINE $A808;
  326.     {$ENDC}
  327. PROCEDURE GetItemCmd(theMenu: MenuRef; item: INTEGER; VAR cmdChar: CHAR);
  328.     {$IFC NOT GENERATINGCFM}
  329.     INLINE $A84E;
  330.     {$ENDC}
  331. PROCEDURE SetItemCmd(theMenu: MenuRef; item: INTEGER; cmdChar: CHAR);
  332.     {$IFC NOT GENERATINGCFM}
  333.     INLINE $A84F;
  334.     {$ENDC}
  335. FUNCTION PopUpMenuSelect(menu: MenuRef; top: INTEGER; left: INTEGER; popUpItem: INTEGER): LONGINT;
  336.     {$IFC NOT GENERATINGCFM}
  337.     INLINE $A80B;
  338.     {$ENDC}
  339. FUNCTION MenuChoice: LONGINT;
  340.     {$IFC NOT GENERATINGCFM}
  341.     INLINE $AA66;
  342.     {$ENDC}
  343. PROCEDURE DeleteMCEntries(menuID: INTEGER; menuItem: INTEGER);
  344.     {$IFC NOT GENERATINGCFM}
  345.     INLINE $AA60;
  346.     {$ENDC}
  347. FUNCTION GetMCInfo: MCTableHandle;
  348.     {$IFC NOT GENERATINGCFM}
  349.     INLINE $AA61;
  350.     {$ENDC}
  351. PROCEDURE SetMCInfo(menuCTbl: MCTableHandle);
  352.     {$IFC NOT GENERATINGCFM}
  353.     INLINE $AA62;
  354.     {$ENDC}
  355. PROCEDURE DisposeMCInfo(menuCTbl: MCTableHandle);
  356.     {$IFC NOT GENERATINGCFM}
  357.     INLINE $AA63;
  358.     {$ENDC}
  359. FUNCTION GetMCEntry(menuID: INTEGER; menuItem: INTEGER): MCEntryPtr;
  360.     {$IFC NOT GENERATINGCFM}
  361.     INLINE $AA64;
  362.     {$ENDC}
  363. PROCEDURE SetMCEntries(numEntries: INTEGER; menuCEntries: MCTablePtr);
  364.     {$IFC NOT GENERATINGCFM}
  365.     INLINE $AA65;
  366.     {$ENDC}
  367. PROCEDURE InsertFontResMenu(theMenu: MenuRef; afterItem: INTEGER; scriptFilter: INTEGER);
  368.     {$IFC NOT GENERATINGCFM}
  369.     INLINE $303C, $0400, $A825;
  370.     {$ENDC}
  371. PROCEDURE InsertIntlResMenu(theMenu: MenuRef; theType: ResType; afterItem: INTEGER; scriptFilter: INTEGER);
  372.     {$IFC NOT GENERATINGCFM}
  373.     INLINE $303C, $0601, $A825;
  374.     {$ENDC}
  375. FUNCTION SystemEdit(editCmd: INTEGER): BOOLEAN;
  376.     {$IFC NOT GENERATINGCFM}
  377.     INLINE $A9C2;
  378.     {$ENDC}
  379. PROCEDURE SystemMenu(menuResult: LONGINT);
  380.     {$IFC NOT GENERATINGCFM}
  381.     INLINE $A9B5;
  382.     {$ENDC}
  383. {$IFC OLDROUTINENAMES }
  384. PROCEDURE AddResMenu(theMenu: MenuRef; theType: ResType);
  385.     {$IFC NOT GENERATINGCFM}
  386.     INLINE $A94D;
  387.     {$ENDC}
  388. PROCEDURE InsMenuItem(theMenu: MenuRef; itemString: ConstStr255Param; afterItem: INTEGER);
  389.     {$IFC NOT GENERATINGCFM}
  390.     INLINE $A826;
  391.     {$ENDC}
  392. PROCEDURE DelMenuItem(theMenu: MenuRef; item: INTEGER);
  393.     {$IFC NOT GENERATINGCFM}
  394.     INLINE $A952;
  395.     {$ENDC}
  396. PROCEDURE SetItem(theMenu: MenuRef; item: INTEGER; itemString: ConstStr255Param);
  397.     {$IFC NOT GENERATINGCFM}
  398.     INLINE $A947;
  399.     {$ENDC}
  400. PROCEDURE GetItem(theMenu: MenuRef; item: INTEGER; VAR itemString: Str255);
  401.     {$IFC NOT GENERATINGCFM}
  402.     INLINE $A946;
  403.     {$ENDC}
  404. FUNCTION GetMHandle(menuID: INTEGER): MenuRef;
  405.     {$IFC NOT GENERATINGCFM}
  406.     INLINE $A949;
  407.     {$ENDC}
  408. PROCEDURE DelMCEntries(menuID: INTEGER; menuItem: INTEGER);
  409.     {$IFC NOT GENERATINGCFM}
  410.     INLINE $AA60;
  411.     {$ENDC}
  412. PROCEDURE DispMCInfo(menuCTbl: MCTableHandle);
  413.     {$IFC NOT GENERATINGCFM}
  414.     INLINE $AA63;
  415.     {$ENDC}
  416. {$ENDC}
  417.  
  418. {$ALIGN RESET}
  419. {$POP}
  420.  
  421. {$SETC UsingIncludes := MenusIncludes}
  422.  
  423. {$ENDC} {__MENUS__}
  424.  
  425. {$IFC NOT UsingIncludes}
  426.  END.
  427. {$ENDC}
  428.